Remove redundant Pinterest API error handlers #1087

message-dimke · 2024-11-18T19:44:26Z

Changes proposed in this Pull Request:

Removing the Action Scheduler (AS) action failure hook to disconnect the extension on the Pinterest API call failures from inside the AS actions.

Customers complain about this issue when saying that after a while of the successful connection, the extension gets disconnected.

This is a requested feature that did not work out. Users prefer to stay connected even if the application is not partially working.

Detailed test instructions:

Download the extension and connect to your Pinterest account.
Edit the code lines below by adding a filter to emulate the request failure

pinterest-for-woocommerce/src/API/APIV5.php

Lines 524 to 530 in 1552a0f

    
           public static function create_feed( array $data, string $ad_account_id ): array { 
        
           	return self::make_request( 
        
           		"catalogs/feeds?ad_account_id={$ad_account_id}", 
        
           		'POST', 
        
           		$data 
        
           	); 
        
           }

add exactly before the return statement:

add_filter(
	'pre_http_request',
	function ( $response, $parsed_args, $url ) use ( $ad_account_id ) {
		if ( "https://api.pinterest.com/v5/catalogs/feeds?ad_account_id={$ad_account_id}" === $url ) {
			return array(
				'headers'  => array(
					'content-type' => 'application/json',
				),
				'body'     => json_encode(
					array(
						'code'    => 2625,
						'message' => 'Sorry, you cannot perform this action as your account has been disapproved. Please see business hub for more details. https://www.pinterest.com/business/hub/',
					)
				),
				'response' => array(
					'code'    => 403,
					'message' => 'Forbidden',
				),
				'cookies'  => array(),
				'filename' => '',
			);
		}
	},
	10,
	3
);

Go to WooCommerce - Status - Scheduler Actions - Pending

WooCommerce_status_‹_WordPress_Pinterest_—_WordPress

Force run the pinterest-for-woocommerce-handle-feed-registration action.
Observe that the extension stayed connected and did not reset back to the onboarding flow.

Changelog entry

Update - Do not disconnect on the Action Scheduler action failure.

… Having 403 as the reason of disconnection was causing Pinterest account to disconnect due to account status change and feed actions returning 403 http responses.

…tion handler. Action scheduler uses Pinterest APIs exceptions from which are handled by APIV5 class, no need in doubling the handling effort, making multiple disconnects per a single API failure.

…f tests.

…ethods which do not throw anything. - Updating the repeating error message making it more clear on what is going on and what was the previous exception. - Refactoring Pinterest API Exception supported data types.

…st API response error code.

…admin notices for the Pinterest API errors which may appear during feed registration.

…o account error. - Hooking into admin exception admin notice and disconnect actions within feed generation action to show and hide account failure notices.

… exceptions while running it.

…ort it.

…l information about the failure. Returning boolean false, in this case, will mark action as failed w/o the exception.

… add/notices-for-important-api-exceptions

rawdreeg

Thanks @message-dimke. The changes test well. The interest connection is not removed on failed pinterest-for-woocommerce-handle-feed-registration action.

…pi-exceptions Add notices for important api exceptions

…-exceptions Update Action Scheduler actions to fail with exceptions.

message-dimke added 3 commits November 18, 2024 20:20

Removing 403 out of action scheduler failed execution action handler.…

bb7473c

… Having 403 as the reason of disconnection was causing Pinterest account to disconnect due to account status change and feed actions returning 403 http responses.

Removing action scheduler failed execution action Pinterest API excep…

e5f0bf1

…tion handler. Action scheduler uses Pinterest APIs exceptions from which are handled by APIV5 class, no need in doubling the handling effort, making multiple disconnects per a single API failure.

Reverting changes back.

657fc28

github-actions bot added the changelog: update Big changes to something that wasn't broken. label Nov 18, 2024

Removing action scheduler failed execution action handler check out o…

1552a0f

…f tests.

message-dimke self-assigned this Nov 18, 2024

message-dimke added 10 commits November 20, 2024 14:19

Removing unused use directives.

491118d

Fixing phpcs.

eea724b

Fixing phpcs.

1c4d4ca

Adding action to hook in to add admin notice depending on the Pintere…

ca4d5ba

…st API response error code.

Adding show admin notice action for feed registration action to show …

c21386d

…admin notices for the Pinterest API errors which may appear during feed registration.

Adding account disapproved admin notice class.

85aa61c

Fixing phpcs.

bfdee85

- Renaming note class into something more general but still related t…

b49f8af

…o account error. - Hooking into admin exception admin notice and disconnect actions within feed generation action to show and hide account failure notices.

Fixing phpcs

96d9107

message-dimke requested a review from a team November 21, 2024 07:17

message-dimke marked this pull request as ready for review November 21, 2024 07:17

message-dimke added 5 commits November 21, 2024 09:21

Updating the phpDoc class and file descriptions.

91d825a

Making feed registration action not to exit silently if there are any…

4a23384

… exceptions while running it.

Making commerce integration sync action to fail with exception to rep…

8fa36f9

…ort it.

Removing the redundant exception which does not provide any meaningfu…

8b87c15

…l information about the failure. Returning boolean false, in this case, will mark action as failed w/o the exception.

Merge branch 'refs/heads/update/actions-to-fail-with-exceptions' into…

9806164

… add/notices-for-important-api-exceptions

rawdreeg approved these changes Nov 25, 2024

View reviewed changes

message-dimke added 2 commits December 3, 2024 10:34

Merge pull request #1089 from woocommerce/add/notices-for-important-a…

68a1731

…pi-exceptions Add notices for important api exceptions

Merge pull request #1088 from woocommerce/update/actions-to-fail-with…

55cdff6

…-exceptions Update Action Scheduler actions to fail with exceptions.

message-dimke merged commit 6f91384 into develop Dec 3, 2024
4 checks passed

message-dimke deleted the update/remove-403-disconnect-reason branch December 3, 2024 09:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove redundant Pinterest API error handlers #1087

Remove redundant Pinterest API error handlers #1087

message-dimke commented Nov 18, 2024 •

edited

Loading

rawdreeg left a comment

	public static function create_feed( array $data, string $ad_account_id ): array {
	return self::make_request(
	"catalogs/feeds?ad_account_id={$ad_account_id}",
	'POST',
	$data
	);
	}

Remove redundant Pinterest API error handlers #1087

Remove redundant Pinterest API error handlers #1087

Conversation

message-dimke commented Nov 18, 2024 • edited Loading

Changes proposed in this Pull Request:

Detailed test instructions:

Changelog entry

rawdreeg left a comment

Choose a reason for hiding this comment

message-dimke commented Nov 18, 2024 •

edited

Loading